xportethxe 2.2.1
Loading...
Searching...
No Matches
xportethxe.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2026 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
27
28#ifndef XPORTETHXE_H
29#define XPORTETHXE_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
39#ifdef PREINIT_SUPPORTED
40#include "preinit.h"
41#endif
42
43#ifdef MikroCCoreVersion
44 #if MikroCCoreVersion >= 1
45 #include "delays.h"
46 #endif
47#endif
48
49#include "drv_digital_out.h"
50#include "drv_digital_in.h"
51#include "drv_uart.h"
52
58
63
68
73#define XPORTETHXE_CMD_MODE_CONFIG "xxx"
74#define XPORTETHXE_CMD_MODE_MONITOR "yyy"
75#define XPORTETHXE_CMD_MODE_MONITOR_WITH_NET "zzz"
76#define XPORTETHXE_CMD_ENTER "\r"
77#define XPORTETHXE_CMD_AT "AT"
78#define XPORTETHXE_CMD_SET_IP "co"
79#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_0 "G0"
80#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_1 "G1"
81#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_2 "G2"
82#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_3 "G3"
83#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_4 "G4"
84#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_5 "G5"
85#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_6 "G6"
86#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_7 "G7"
87#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_8 "G8"
88#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_9 "G9"
89#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_A "Ga"
90#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_B "Gb"
91#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_C "Gc"
92#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_D "Gd"
93#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_E "Ge"
94#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_F "Gf"
95#define XPORTETHXE_CMD_GET_IP_CONFIG(ADR) "GC " ADR
96#define XPORTETHXE_CMD_GET_MAC_ADDRESS "GM"
97#define XPORTETHXE_CMD_NET_CONN "NC"
98#define XPORTETHXE_CMD_NET_STAT "NS"
99#define XPORTETHXE_CMD_PING(ADR) "PI " ADR
100#define XPORTETHXE_CMD_QUIT "QU"
101#define XPORTETHXE_CMD_RESET "RS"
102#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_0 "S0"
103#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_1 "S1"
104#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_2 "S2"
105#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_3 "S3"
106#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_4 "S4"
107#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_5 "S5"
108#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_6 "S6"
109#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_7 "S7"
110#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_8 "S8"
111#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_9 "S9"
112#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_A "Sa"
113#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_B "Sb"
114#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_C "Sc"
115#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_D "Sd"
116#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_E "Se"
117#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_F "Sf"
118#define XPORTETHXE_CMD_SCAN "SA"
119#define XPORTETHXE_CMD_SEND_CONFIG(ADR) "SC " ADR
120#define XPORTETHXE_CMD_SET_SECURITY_RECORD "SS"
121#define XPORTETHXE_CMD_SET_SECURITY_RECORD "SS"
122#define XPORTETHXE_CMD_TCP_CONN_TABLE "TT"
123#define XPORTETHXE_CMD_QUERY_FW_VERSION "VN"
124#define XPORTETHXE_CMD_VERSION(ADR) "VS " ADR
125#define XPORTETHXE_CMD_FLASH_WRITE_COUNT "WC"
126
131#define XPORTETHXE_RSP_OK "0>"
132#define XPORTETHXE_RSP_NO_ANSWER "1>"
133#define XPORTETHXE_RSP_NO_REACH "2>"
134#define XPORTETHXE_RSP_WRONG_PAR "8>"
135#define XPORTETHXE_RSP_INVALID_CMD "9>"
136
142#define XPORTETHXE_TX_DRV_BUFFER_SIZE 200
143#define XPORTETHXE_RX_DRV_BUFFER_SIZE 1000
144 // xportethxe_cmd
146
151
156
161#define XPORTETHXE_MAP_MIKROBUS( cfg, mikrobus ) \
162 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
163 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
164 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
165 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
166 cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
167 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
168 // xportethxe_map // xportethxe
171
176typedef struct
177{
178 // Output pins
179 digital_out_t rst;
180 digital_out_t cts;
181
182 // Input pins
183 digital_in_t dtr;
184 digital_in_t rts;
185
186 // Modules
187 uart_t uart;
188
189 // Buffers
192
194
199typedef struct
200{
201 // Communication gpio pins
202 pin_name_t rx_pin;
203 pin_name_t tx_pin;
204
205 // Additional gpio pins
206 pin_name_t rst;
207 pin_name_t cts;
208 pin_name_t dtr;
209 pin_name_t rts;
210
211 // Static variable
212 uint32_t baud_rate;
214 uart_data_bits_t data_bit;
215 uart_parity_t parity_bit;
216 uart_stop_bits_t stop_bit;
217
219
232
238
249
264
277err_t xportethxe_generic_write ( xportethxe_t *ctx, uint8_t *data_in, uint16_t len );
278
291err_t xportethxe_generic_read ( xportethxe_t *ctx, uint8_t *data_out, uint16_t len );
292
302void xportethxe_send_cmd ( xportethxe_t *ctx, uint8_t *cmd );
303
313
323void xportethxe_set_rst_pin ( xportethxe_t *ctx, uint8_t state );
324
334void xportethxe_set_cts_pin ( xportethxe_t *ctx, uint8_t state );
335
345
355
365
366#ifdef __cplusplus
367}
368#endif
369#endif // XPORTETHXE_H
370 // xportethxe
372
373// ------------------------------------------------------------------------ END
#define XPORTETHXE_TX_DRV_BUFFER_SIZE
XPort ETH XE driver buffer size.
Definition xportethxe.h:142
#define XPORTETHXE_RX_DRV_BUFFER_SIZE
Definition xportethxe.h:143
uint8_t xportethxe_get_rts_pin(xportethxe_t *ctx)
XPort ETH XE get RTS pin function.
void xportethxe_set_cts_pin(xportethxe_t *ctx, uint8_t state)
XPort ETH XE set CTS pin function.
void xportethxe_cfg_setup(xportethxe_cfg_t *cfg)
XPort ETH XE configuration object setup function.
void xportethxe_reset_device(xportethxe_t *ctx)
XPort ETH XE reset device function.
err_t xportethxe_generic_read(xportethxe_t *ctx, uint8_t *data_out, uint16_t len)
XPort ETH XE data reading function.
err_t xportethxe_init(xportethxe_t *ctx, xportethxe_cfg_t *cfg)
XPort ETH XE initialization function.
err_t xportethxe_generic_write(xportethxe_t *ctx, uint8_t *data_in, uint16_t len)
XPort ETH XE data writing function.
uint8_t xportethxe_get_dtr_pin(xportethxe_t *ctx)
XPort ETH XE get DTR pin function.
void xportethxe_set_rst_pin(xportethxe_t *ctx, uint8_t state)
XPort ETH XE set RST pin function.
void xportethxe_send_enter(xportethxe_t *ctx)
XPort ETH XE send enter function.
void xportethxe_send_cmd(xportethxe_t *ctx, uint8_t *cmd)
XPort ETH XE send cmd function.
XPort ETH XE Click configuration object.
Definition xportethxe.h:200
pin_name_t dtr
Definition xportethxe.h:208
pin_name_t rts
Definition xportethxe.h:209
uint32_t baud_rate
Definition xportethxe.h:212
pin_name_t cts
Definition xportethxe.h:207
bool uart_blocking
Definition xportethxe.h:213
uart_data_bits_t data_bit
Definition xportethxe.h:214
pin_name_t tx_pin
Definition xportethxe.h:203
pin_name_t rx_pin
Definition xportethxe.h:202
uart_stop_bits_t stop_bit
Definition xportethxe.h:216
uart_parity_t parity_bit
Definition xportethxe.h:215
pin_name_t rst
Definition xportethxe.h:206
XPort ETH XE Click context object.
Definition xportethxe.h:177
uint8_t uart_rx_buffer[XPORTETHXE_RX_DRV_BUFFER_SIZE]
Definition xportethxe.h:190
uart_t uart
Definition xportethxe.h:187
digital_in_t rts
Definition xportethxe.h:184
digital_out_t rst
Definition xportethxe.h:179
digital_out_t cts
Definition xportethxe.h:180
uint8_t uart_tx_buffer[XPORTETHXE_TX_DRV_BUFFER_SIZE]
Definition xportethxe.h:191
digital_in_t dtr
Definition xportethxe.h:183
xportethxe_return_value_t
XPort ETH XE Click return value data.
Definition xportethxe.h:225
@ XPORTETHXE_ERROR_CMD
Definition xportethxe.h:229
@ XPORTETHXE_ERROR_TIMEOUT
Definition xportethxe.h:228
@ XPORTETHXE_OK
Definition xportethxe.h:226
@ XPORTETHXE_ERROR
Definition xportethxe.h:227